home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / cggev.z / cggev
Encoding:
Text File  |  2002-10-03  |  7.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGGGGGEEEEVVVV((((3333SSSS))))                                                            CCCCGGGGGGGGEEEEVVVV((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGGEV - compute for a pair of N-by-N complex nonsymmetric matrices (A,B),
  10.      the generalized eigenvalues, and optionally, the left and/or right
  11.      generalized eigenvectors
  12.  
  13. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.      SUBROUTINE CGGEV( JOBVL, JOBVR, N, A, LDA, B, LDB, ALPHA, BETA, VL, LDVL,
  15.                        VR, LDVR, WORK, LWORK, RWORK, INFO )
  16.  
  17.          CHARACTER     JOBVL, JOBVR
  18.  
  19.          INTEGER       INFO, LDA, LDB, LDVL, LDVR, LWORK, N
  20.  
  21.          REAL          RWORK( * )
  22.  
  23.          COMPLEX       A( LDA, * ), ALPHA( * ), B( LDB, * ), BETA( * ), VL(
  24.                        LDVL, * ), VR( LDVR, * ), WORK( * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      CGGEV computes for a pair of N-by-N complex nonsymmetric matrices (A,B),
  41.      the generalized eigenvalues, and optionally, the left and/or right
  42.      generalized eigenvectors. A generalized eigenvalue for a pair of matrices
  43.      (A,B) is a scalar lambda or a ratio alpha/beta = lambda, such that A -
  44.      lambda*B is singular. It is usually represented as the pair (alpha,beta),
  45.      as there is a reasonable interpretation for beta=0, and even for both
  46.      being zero.
  47.  
  48.      The right generalized eigenvector v(j) corresponding to the generalized
  49.      eigenvalue lambda(j) of (A,B) satisfies
  50.  
  51.                   A * v(j) = lambda(j) * B * v(j).
  52.  
  53.      The left generalized eigenvector u(j) corresponding to the generalized
  54.      eigenvalues lambda(j) of (A,B) satisfies
  55.  
  56.                   u(j)**H * A = lambda(j) * u(j)**H * B
  57.  
  58.      where u(j)**H is the conjugate-transpose of u(j).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGGGGGEEEEVVVV((((3333SSSS))))                                                            CCCCGGGGGGGGEEEEVVVV((((3333SSSS))))
  71.  
  72.  
  73.  
  74. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  75.      JOBVL   (input) CHARACTER*1
  76.              = 'N':  do not compute the left generalized eigenvectors;
  77.              = 'V':  compute the left generalized eigenvectors.
  78.  
  79.      JOBVR   (input) CHARACTER*1
  80.              = 'N':  do not compute the right generalized eigenvectors;
  81.              = 'V':  compute the right generalized eigenvectors.
  82.  
  83.      N       (input) INTEGER
  84.              The order of the matrices A, B, VL, and VR.  N >= 0.
  85.  
  86.      A       (input/output) COMPLEX array, dimension (LDA, N)
  87.              On entry, the matrix A in the pair (A,B).  On exit, A has been
  88.              overwritten.
  89.  
  90.      LDA     (input) INTEGER
  91.              The leading dimension of A.  LDA >= max(1,N).
  92.  
  93.      B       (input/output) COMPLEX array, dimension (LDB, N)
  94.              On entry, the matrix B in the pair (A,B).  On exit, B has been
  95.              overwritten.
  96.  
  97.      LDB     (input) INTEGER
  98.              The leading dimension of B.  LDB >= max(1,N).
  99.  
  100.      ALPHA   (output) COMPLEX array, dimension (N)
  101.              BETA    (output) COMPLEX array, dimension (N) On exit,
  102.              ALPHA(j)/BETA(j), j=1,...,N, will be the generalized eigenvalues.
  103.  
  104.              Note: the quotients ALPHA(j)/BETA(j) may easily over- or
  105.              underflow, and BETA(j) may even be zero.  Thus, the user should
  106.              avoid naively computing the ratio alpha/beta.  However, ALPHA
  107.              will be always less than and usually comparable with norm(A) in
  108.              magnitude, and BETA always less than and usually comparable with
  109.              norm(B).
  110.  
  111.      VL      (output) COMPLEX array, dimension (LDVL,N)
  112.              If JOBVL = 'V', the left generalized eigenvectors u(j) are stored
  113.              one after another in the columns of VL, in the same order as
  114.              their eigenvalues.  Each eigenvector will be scaled so the
  115.              largest component will have abs(real part) + abs(imag. part) = 1.
  116.              Not referenced if JOBVL = 'N'.
  117.  
  118.      LDVL    (input) INTEGER
  119.              The leading dimension of the matrix VL. LDVL >= 1, and if JOBVL =
  120.              'V', LDVL >= N.
  121.  
  122.      VR      (output) COMPLEX array, dimension (LDVR,N)
  123.              If JOBVR = 'V', the right generalized eigenvectors v(j) are
  124.              stored one after another in the columns of VR, in the same order
  125.              as their eigenvalues.  Each eigenvector will be scaled so the
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGGGGGEEEEVVVV((((3333SSSS))))                                                            CCCCGGGGGGGGEEEEVVVV((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              largest component will have abs(real part) + abs(imag. part) = 1.
  141.              Not referenced if JOBVR = 'N'.
  142.  
  143.      LDVR    (input) INTEGER
  144.              The leading dimension of the matrix VR. LDVR >= 1, and if JOBVR =
  145.              'V', LDVR >= N.
  146.  
  147.      WORK    (workspace/output) COMPLEX array, dimension (LWORK)
  148.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  149.  
  150.      LWORK   (input) INTEGER
  151.              The dimension of the array WORK.  LWORK >= max(1,2*N).  For good
  152.              performance, LWORK must generally be larger.
  153.  
  154.              If LWORK = -1, then a workspace query is assumed; the routine
  155.              only calculates the optimal size of the WORK array, returns this
  156.              value as the first entry of the WORK array, and no error message
  157.              related to LWORK is issued by XERBLA.
  158.  
  159.      RWORK   (workspace/output) REAL array, dimension (8*N)
  160.  
  161.      INFO    (output) INTEGER
  162.              = 0:  successful exit
  163.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  164.              =1,...,N:  The QZ iteration failed.  No eigenvectors have been
  165.              calculated, but ALPHA(j) and BETA(j) should be correct for
  166.              j=INFO+1,...,N.  > N:  =N+1: other then QZ iteration failed in
  167.              SHGEQZ,
  168.              =N+2: error return from STGEVC.
  169.  
  170. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  171.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  172.  
  173.      This man page is available only online.
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.